/*
 * Copyright 2012-2017 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.test.context;

import java.util.function.Supplier;

import org.springframework.web.context.ConfigurableWebApplicationContext;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;

/**
 * A {@link ContextLoader} that simulates a {@link AnnotationConfigWebApplicationContext}
 * which can be useful to test components that require a servlet web application.
 *
 * @author Andy Wilkinson
 * @author Stephane Nicoll
 * @since 2.0.0
 */
public final class ServletWebContextLoader extends
		AbstractContextLoader<AnnotationConfigWebApplicationContext, ServletWebContextLoader> {

	ServletWebContextLoader(
			Supplier<AnnotationConfigWebApplicationContext> contextSupplier) {
		super(contextSupplier);
	}

	/**
	 * Create and refresh a new {@link ConfigurableWebApplicationContext} based on the
	 * current state of this loader. The context is consumed by the specified
	 * {@link WebMvcContextConsumer consumer} and closed upon completion.
	 * @param consumer the consumer of the created
	 * {@link ConfigurableWebApplicationContext}
	 */
	public void loadWeb(WebMvcContextConsumer consumer) {
		doLoad(consumer::accept);
	}

}
